home *** CD-ROM | disk | FTP | other *** search
/ BCI NET / BCI NET Dec 94.iso / archives / telecomm / misc / ne1_2.lha / ne / doc / ne.doc < prev    next >
Encoding:
Text File  |  1994-11-11  |  16.4 KB  |  564 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.                                    ne.guide
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.                          Generated with Heddley v1.1
  33.                       Heddley v1.1 (C) Edd Dumbill 1994
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.                                   - Page 1 -
  73.  
  74.  
  75.  
  76. 1.    ne.guide
  77.  
  78.  
  79.  
  80.   Name:      NE
  81.  
  82.   Version:   1.20
  83.  
  84.   Format:    NE [DEVICE=<Device>]           [UNIT=<Unit>]
  85.                 [LOGFILE=<Filename>]        [COMMAND1=<Command>]
  86.                 [COMMAND2=<Command>]        [T1=<Time in secs>]
  87.                 [T2=<Time in secs>]         [T3=<Time in secs>]
  88.                 [MODEMINIT=<Modemcommand>]  [RingCommand=<Command>]
  89.                 [DEBUG]                     [HELP]
  90.  
  91.   Template: DEVICE/K,UNIT/N,LOGFILE/K,COMMAND1/K,COMMAND2/K,T1/N,T2/N,
  92.             T3/N,MODEMINIT/K,RINGCOMMAND/K,DEBUG/S,HELP/S
  93.  
  94.  
  95.   Function: NE can be used to provide a data-login via the connected mo-
  96.             dem at  any time, even  if the telephone  line is used  by a
  97.             answer machine  or a fax machine  or simply as a voice line.
  98.             It can be  used in  cooperation with  Getty or a similar
  99.             program.
  100.             NE uses the locking mechanism of the OwnDevUnit.library.
  101.  
  102.  
  103.                                Manual                    
  104.  
  105.  
  106. 2.    ne.guide
  107.  
  108.  
  109.  
  110.      Manual for NE:
  111.  
  112.          Copyright              Copyright and Copying
  113.          Why NE ?               Why NE?
  114.          Function               How does NE work?
  115.          Installation           How to install NE?
  116.          Exiting                How to quit NE?
  117.          Requirements           System requirements for NE
  118.          Parameters             What do all these parameters mean ?
  119.          Examples               How to use NE
  120.          Known Bugs             The known bugs of NE
  121.          History                The history of NE so far...
  122.          Todo                   The todo-list of NE
  123.          Credits                The authors would like to thank...
  124.          Autoren                Who are these authors anyway?
  125.  
  126. 3.    ne.guide
  127.  
  128.  Copyright and Copying:
  129.  
  130. NE is Copright (C) 1993, 1994 by Klaus Mueller und Thomas Freudling.
  131.  
  132. NE can be copied but only for non-profit reasons.  The maximum price for it
  133. should be the disk price plus postage.  Redistribution of a changed program
  134. and/or  documentation is strictly prohibited!  Any form of commercial usage
  135. without knowledge of the authors is also prohibited.
  136.  
  137. There is no  shareware fee or similar for this program at the moment but it
  138. shouldn`t prevent  anybody from expressing  his/her acknowledgement  to the
  139. authors through eMail or regular mail. However this should not prevent any-
  140. body from sending money or other stuff which can be useful in real life.
  141. ;-)))
  142.  
  143.  
  144.                                   - Page 2 -
  145. 3.    ne.guide
  146.  
  147. There is no warranty when using NE!  We are not responsible for any loss of
  148. data or any  kind of trouble caused by NE.  Use it at your own risk!  We do
  149. not guarantee that all the functions work as described in the manual.
  150.  
  151. 4.    ne.guide
  152.  
  153.  
  154.                         The Authors:
  155.  
  156.        Klaus Mueller:              Thomas Freudling:
  157.  
  158. Snail: Ludwigstrasse 33            Kanalstrasse 5
  159.        86316 Friedberg             88457 Kirchdorf
  160.        Germany                     Germany
  161.  
  162. eMail: max@tripos.augusta.de       nemo@izeps.augusta.de
  163.  
  164. 5.    ne.guide
  165.  
  166.  Why Ne ?
  167.  
  168. NE was written to solve a problem that  many modem users share if they want to
  169. allow a remote login on their computer without paying for a second tele- phone
  170. line.  Therefore a friend of ours  wrote a  small  script  using the script
  171. language of the  terminalprogram  NComm that  solved this problem in the
  172. following way:
  173.  
  174. The script  waited for a RING sign from the modem.  After the first ring it
  175. waited some time for another ring.  If there were other rings following the
  176. first the script  interpreted it as a normal telephone  call and it did no-
  177. thing. But if there was only one ring it was interpreted as an announcement
  178. for a remote  login and the script waited some  time for the next call.  If
  179. there was a second  call within a specified time, the script  answered this
  180. call at the first ring and a login was possible. Very similar to this works
  181. NE.  NE therefore  stands for the  german term `NComm-Ersatz`, which  means
  182. `NComm-Replacement` as it was written  simply for that  reason in the first
  183. place.  And as you know that programmers hate to type long filenames it was
  184. abbreviated to `NE`. :-)
  185.  
  186. The advantage of  this method is obvious: Nearly all fax machines or answer
  187. machines wait  for a second ring.  Anybody who knows  about the program has to
  188. call once for the  first ring and to drop the line  before the answer or fax
  189. machine answers.  If the second call comes  within a specified time the
  190. computer goes  off hook at the first ring sign  even before a answer or fax
  191. machine can answer the call.  Using this method it is possible to make your
  192. computer accessible 24 hours a day without paying for a data phoneline.
  193.  
  194. "Normal" callers usually don`t  introduce themselves by calling once and so
  195. they are ignored  by NE and the call  can be answered  personally or by one of
  196. the machines mentioned above.
  197.  
  198.  
  199. 6.    ne.guide
  200.  
  201.  Function:
  202.  
  203. NE works in cooperation with Getty or a similar program. NE locks the modem
  204. until it  detects one single  RING sign which is  NOT followed  by a second
  205.  one. If this is the case NE frees  the modem and a parallel  running Getty
  206. should take  control over  the modem.  If  everything is configured  appro-
  207. priately, Getty should answer the next call.
  208.  
  209. After a specified  time NE is trying to take control over  the modem again. If
  210. there was no remote login, Getty will be repressed by NE again. If there is
  211. somebody  logged into your  computer, NE waits until  the modem hangs up
  212. because Getty can only be repressed when the modem is free.
  213.  
  214. NOTICE:  This is only  possible if Getty  (or some other program)  uses the
  215.  
  216.                                   - Page 3 -
  217. 6.    ne.guide
  218.  
  219. locking  mechanism  of the  OwnDevUnit.library.  You have to  use the Getty
  220. that comes with AmigaUUCP V1.16 or some other version >= 1.16.
  221.  
  222. Everytime NE  takes over, ATZ is sent  to the modem to reset it.  The modem
  223. settings are set to the default values.  NE uses the baud rate specified in
  224. the preferences program.  It is always possible to  repress NE by using the
  225. OwnDevUnit.library.  Programs like uucico  (>= version 1.16), LockSerial or
  226. LockSer can easily regain control over the modem even if NE is running.
  227.  
  228. Programs which want to access the serial port without using the OwnDevUnit-
  229. .library must be started with `LockSerial` or `LockSer`.
  230.  
  231. To quit NE simply send a CTRL-C (i.e. a `break`) using the C:Break command.
  232.  
  233. 7.    ne.guide
  234.  
  235.  Installation:
  236.  
  237. - Copy NE into a directory somewhere in your search path.
  238.  
  239. - Getty and NE should be started in S:User-Startup or SYS:WBStartup.  Getty
  240.   should be configured in a way  that it answers a call in  less ring signs
  241.   than the connected fax or answer machine.
  242.  
  243. 8.    ne.guide
  244.  
  245.  Qutting NE:
  246.  
  247. Simply send a CTRL-C to the  shell process in which NE is running.  You can do
  248. this via the C:Break command.
  249.  
  250. 9.    ne.guide
  251.  
  252.  Requirements:
  253.  
  254. - NE only works with version 2.0 or greater of the operating system. - NE only
  255. works with Hayes compatible modems.
  256.  
  257. - NE was developed on a Amiga 4000/040 running version 3.0 of the operating
  258.   system. It was compiled using the SAS/C Compiler Version 6.51.
  259.  
  260.   It was tested on the following configurations:
  261.  
  262.   Amiga 4000/040 with ZyXEL U1496E modem
  263.   Amiga 4000/040 with Supra V.32bis modem
  264.   Amiga 3000-25 with ZyXEL U1496E+ modem
  265.   Amiga 3000-25 with Supra V.32bis modem
  266.   Amiga 3000-25 with U.S. Robotics Dual Standard modem
  267.  
  268.   (sorry, no vanilla models available for testing... ;-)
  269.  
  270.   The following OS versions were used:
  271.  
  272.   OS 3.0 (Kickstart 39.106, Workbench 39.29)
  273.   OS 2.1 (Kickstart 37.175, Workbench 38.35)
  274.  
  275. The following serial boards were used during the test phase:
  276.  
  277.   MultiFaceCard II and III
  278.   HK VectorConnection
  279.   GVP IOExtender
  280.  
  281.  
  282. 10.    ne.guide
  283.  
  284.  Parameters:
  285.  
  286. All parameters are optional. If a parameter wasn`t specified at the command
  287.  
  288.                                   - Page 4 -
  289. 10.    ne.guide
  290.  
  291. line the default value is used.
  292.  
  293.         Parameter:       Defaultvalue:
  294.  
  295.         DEVICE          serial.device
  296.         UNIT            0
  297.         LOGFILE         log:ne.log
  298.         COMMAND1        - <no command> -
  299.         COMMAND2        - <no command> -
  300.         T1              8  secs.
  301.         T2              10 secs.
  302.         T3              60 secs.
  303.         MODEMINIT       - <no init-string> -
  304.         RINGCOMMAND     - <off> -
  305.         DEBUG           - <off> -
  306.         HELP            - <off> -
  307.  
  308. We  STRONGLY  suggest  first-time  users  not  to  change  the  parameters.
  309. Especially the time-parameters should not be changed.
  310.  
  311. You will find the default values quite suitable for your needs. Even if you
  312. are using some ancient machines sold by the german telephone company for an
  313. enourmous amount of money. ;-)
  314.  
  315. 11.    ne.guide
  316.  
  317.  DEVICE:
  318.  
  319.    The device over which the modem can be used.
  320.    The specified device MUST be compatible to the standard serial.device.
  321.  
  322. 12.    ne.guide
  323.  
  324.  UNIT:
  325.  
  326.    The unit number of the device used by NE.
  327.  
  328. 13.    ne.guide
  329.  
  330.  LOGFILE:
  331.  
  332.    Path and  filename of the logfile.  If you don`t want to  have a logfile
  333.    you can specify NIL: here.
  334.  
  335. 14.    ne.guide
  336.  
  337.  COMMAND1:
  338.  
  339.    A command that is executed in the background by NE after the recognition
  340.    of the first RING signal and a successful free-up of the modem. Here you
  341.    can specify a simple shell script  that informs you about the activities
  342.    of the remote user.
  343.  
  344. 15.    ne.guide
  345.  
  346.  COMMAND2:
  347.  
  348.    A command that is executed in the background by NE after NE has regained
  349.    control over the modem and if there was a time in which NE was repressed
  350.    from the serial port.  This command can be used to  terminate the script
  351.    mentioned in  the section `COMMAND1`  after the remote user  has dropped
  352.    the line.
  353.  
  354. 16.    ne.guide
  355.  
  356.  T1:
  357.  
  358.  
  359.                                   - Page 5 -
  360. 16.    ne.guide
  361.  
  362.    The time in seconds  between two RING signs.  If there is no second RING
  363.    sign within  the specified time, NE interprets  this as one  single ring
  364.    and vanishes from the serial port.
  365.  
  366. 17.    ne.guide
  367.  
  368.  T2:
  369.  
  370.    The time in seconds NE waits until it tries to lock the device again af-
  371.    ter it free`d up the device for the time specified in `T3`.  The maximum
  372.    amount of time after a logoff and the modem takeover is specified here.
  373.  
  374. 18.    ne.guide
  375.  
  376.  T3:
  377.  
  378.    The time in seconds NE frees up the device after a single RING sign. Af-
  379.    ter this period, NE tries to  lock the device again in intervals  of T2-
  380.    seconds.
  381.  
  382. 19.    ne.guide
  383.  
  384.  MODEMINIT:
  385.  
  386.    The  initstring sent to the modem after NE has  regained control over it
  387.    again and "ATZ" was sent to the modem.
  388.  
  389. 20.    ne.guide
  390.  
  391.  RingCommand:
  392.  
  393.    This command is executed by NE after the second RING sign.  Therefore it
  394.    can be used to announce `normal` phone calls.  You can specify a program
  395.    that informs the user sitting at the console. Very useful for people who
  396.    like to hear loud music while working at the computer. :-)
  397.  
  398. 21.    ne.guide
  399.  
  400.  DEBUG:
  401.  
  402.    If this flag is given, lots of debug information is sent to stdout. This
  403.    is only useful when you are searching for errors on your system.
  404.  
  405. 22.    ne.guide
  406.  
  407.  HELP:
  408.  
  409.    NE sends out a small help text to stdout.
  410.  
  411. 23.    ne.guide
  412.  
  413.  Examples:
  414.  
  415.    NE 
  416.       -> The standard call for NE.
  417.  
  418.    NE d=foo.device u=7 l=ram:ne.log
  419.       -> NE is started on foo.device unit 7 and the logfile is ram:ne.log
  420.  
  421.    NE c1=myscript rc=wb2front
  422.       -> Myscript is executed at every remote login. In addition, the Work-
  423.          bench is brought to front if a normal voice call is recognized.
  424.  
  425. 24.    ne.guide
  426.  
  427.  Known Bugs:
  428.  
  429.  
  430.                                   - Page 6 -
  431. 24.    ne.guide
  432.  
  433. - It may be possible  that another caller breaks through  between the first
  434.   RING signal and the second call. Obviously this is not very good for this
  435.   person as the modem whistles and tries to connect to the callers ear. :-)
  436.  
  437. - It may also be possible that a irresolute caller is ringing once and then
  438.   hangs up. In this case the same things happen as described above.
  439.  
  440. - If you are using a modem from U.S. Robotics it may be possible that these
  441.   machines are set to  their default baud rate after  being reset by "ATZ".
  442.   Since NE always sends "ATZ" to the  modem when initializing it, it may be
  443.   possible that the next RING signal sent from the modem to the computer is
  444.   not recognized in the right way.
  445.  
  446.   A workaround for  this is to specify an  additional "AT" at NE`s command-
  447.   line. This should set the modem to the correct baud rate.  You should try
  448.   something like:
  449.  
  450.   NE M=AT <insert your other parameters here>
  451.  
  452.   This occurs at least with the U.S. Robotics Dual Standard  modem on which
  453.   we have tested NE here. `ATI7` brings the following message:
  454.  
  455.   Configuration Profile...
  456.  
  457.   Product type           External
  458.   Options                HST,V32
  459.   Clock Freq             16.0Mhz
  460.   Eprom                  64k
  461.   Ram                    32k
  462.  
  463.   Supervisor date        11/30/90
  464.   IOP date               10/11/90
  465.   DSP date               11/15/90
  466.  
  467.   Supervisor rev         3.0
  468.   IOP rev                1.3
  469.   DSP rev                10
  470.  
  471.   This bug may be corrected in some other revision of the modem firmware.
  472.  
  473. - If the  baud  rate of  the modem is  changed  in any  other way,  i.e. by
  474.   switching  the modem  off and turning  it on again, the same problems may
  475.   occur as described above.
  476.   You can force NE to initialize the modem again by typing ` lockserial
  477.   "wait 1" ` at the shell prompt.
  478.  
  479. - Using Term, be careful with Owndevunit.Library. Because term gives up
  480.   the device when requested by ne. Solvage:
  481.  
  482.   ° Disable the usage of ODU in term (menu-settings-serial opt. UseOdu) 
  483.   ° start term with our LockSer with the check-mode option.             
  484.     examp: "LockSer a c term"                                           
  485.                                                                        
  486.   Now LockSer owns the Serial.device as long as Term is on the line.
  487.  
  488. - using ne with ax-server of axsh:
  489.  
  490.   axsh:etc/rc.server
  491.  
  492.  
  493.   %newshell:      /* AXsh's serial startup command in AX-server */
  494.   lockser c >nil: (file)
  495.  
  496.   file:
  497.   newshell >NIL: AXAUX:serial.device/0/shared/checkcd from
  498. AXsh:etc/remote-startup
  499.  
  500.  
  501.                                   - Page 7 -
  502. 24.    ne.guide
  503.  
  504.  
  505. - (lowercase ON) you are not  allowed to use this tool on  the german phone
  506.   network. (lowercase OFF)
  507.  
  508. 25.    ne.guide
  509.  
  510.  History:
  511.  
  512. 1.20  - minor bugfixes.
  513.         solved problem with blocked shell.
  514.         FreeArgs-problem solved.
  515.         solved problem with used Device w/o ownername. 
  516.  
  517. 1.10  - Rewritten for the SAS/C Compiler
  518.         Bugfix in Log-Routine (no visits from India anymore ;-)
  519.         Changed setting of the SERF_EOFMODE flag so that NE now works with
  520.         the GVP IOExtender Thanks to Stephen L. Johnson <sjohnson@godzilla-
  521.         .speedway.net> for the detailed bugreport
  522.  
  523. 1.00  - First official version
  524.         Option WB2Front removed :-) 
  525.         Ringcommand added
  526.         Negative time values no longer crash timer.device       
  527.  
  528. 0.73b - Option WB2Front added
  529.         Manual re-written in AmigaGuide® format
  530.  
  531. 0.72b - When closing the device EOFMODE is set back now. This could cause
  532.         problems when running UUCP.
  533.  
  534. 0.71b - The modemreset with "ATZ" finally works
  535.  
  536. 0.70b - First beta-release
  537.  
  538.  
  539. 26.    ne.guide
  540.  
  541.  Todo:
  542.  
  543.   ° any suggestions ?
  544.  
  545.  
  546. 27.    ne.guide
  547.  
  548.  Credits:
  549.  
  550. For the inital idea and extensive betatesting we would like to thank
  551.  
  552.                 Willi 'Warrior' Ziegler <warrior@hss.abg.sub.org>
  553.  
  554. also our other betatesters:
  555.  
  556.           Harald 'Slartibartfast' Mayr <marvin@bike.augusta.de>
  557.  
  558.           Juergen 'Araneus' Steiner <araneus@barbar.augusta.de>
  559.  
  560. For the translation of the documentation we would like to thank
  561.  
  562.           Harald 'Slartibartfast' Mayr <marvin@bike.augusta.de>
  563.  
  564.